home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / mult_edi.arc / PRNFORM.HLP < prev    next >
Text File  |  1989-10-21  |  15KB  |  366 lines
  1. PF PRINT FORMATTER
  2.  
  3. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->Print-formatter
  4. KEYSTROKES:    <F2> L P^b
  5.  
  6.     (Immediate Action - No Further Input - Dialog Box) The Print
  7.     Formatter reads the current file, executing all of the
  8.     @FMTCODES[format codes].  It then creates and displays an `interpreted',
  9.     printer-ready file in a new window.   The print formatter
  10.     assigns the same filename as the original, adding a .PRT extension.
  11.  
  12.     The user can modify the .PRT file, send it to the printer, or
  13.     save it and print it from the background via the
  14.     @ME.HLP^DO[DOS print spooler].
  15.  
  16.  
  17. FMTCODES FORMAT CODES
  18.  
  19. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->Format-Codes
  20. KEYSTROKES:    <F2> L C^b
  21.  
  22.     (Sub-Menu, Data Entry and/or Immediate Action)  Selecting the
  23.     format-Codes item from the Layout Menu brings up another
  24.     menu from which you can select the type of print-formatting
  25.     codes to be inserted into the current file.  Subsequent
  26.     selections will either: a) cause that code to be inserted into
  27.     the file at the cursor, or; b) request further input before
  28.     inserting the appropriate code at the cursor.
  29.  
  30.     Multi-Edit supports user-defined codes as well as pre-determined
  31.     formatting codes which can be inserted into the @PF[.PRT file] to
  32.     achieve such effects as: line centering, page breaks, and
  33.     comment lines; special print attributes (expanded, italics,
  34.     underlined); page formatting (line spacing, print margins, page
  35.     length); header and footer definition and placement; and the
  36.     definition and generation of a table of contents.
  37.  
  38.     Some format codes are printer-specific and you should verify the
  39.     printer designations and setup specifications in the @ME.HLP^PR[Print] and
  40.     @ME.HLP^IN[Install] menus before sending the .PRT file to the printer.
  41.  
  42.     The default delimiter (required first character) for all format
  43.     codes is the "." (dot, or period).  However, that can be changed
  44.     through the @ME.HLP^EDITSET[Edit Settings] selection on the Install menu.
  45.  
  46.     The format-codes menu includes the following sub-menus:
  47.  
  48.  
  49.       ┌────@FMTCODEMISC[MISCELLANEOUS]────╖              ┌──────@FMTCODEVAR[VARIABLES]──────╖
  50.       │                     ║              │                     ║
  51.       │  Page Breaks        ║              │  Filename           ║
  52.       │  Center line        ║              │  Time               ║
  53.       │  Comment line       ║              │  Date               ║
  54.       │  Ignore line        ║              │  Page Number        ║
  55.       │  Define user code   ║              ╘═════════════════════╝
  56.       ╘═════════════════════╝
  57.  
  58.  
  59.  
  60.      ┌─────@FMTCODEATT[ATTRIBUTES]──────╖               ┌─────@FMTCODEPGSTUP[PAGE SETUP]──────╖
  61.      │                     ║               │                     ║
  62.      │  Underline Begin    ║               │  Line Spacing       ║
  63.      │  Underline End      ║               │  Page Length        ║
  64.      │  Emphasized Begin   ║               │  Right Margin       ║
  65.      │  Emphasized End     ║               │  Left Margin        ║
  66.      │  Italics Begin      ║               │  Top Margin         ║
  67.      │  Italics End        ║               │  Bottom Margin      ║
  68.      │  Doublewide Begin   ║               │  Form Feeds         ║
  69.      │  Doublewide End     ║               ╘═════════════════════╝
  70.      ╘═════════════════════╝
  71.  
  72.      ┌───@FMTCODEHDRFTR[HEADERS/FOOTERS]───╖                ┌──@TOFC[TABLE OF CONTENTS]──╖
  73.      │                     ║                │                     ║
  74.      │  Define Header      ║                │  Define Table       ║
  75.      │  Define Footer      ║                │  Table Entry        ║
  76.      │  Suppress Header    ║                ╘═════════════════════╝
  77.      │  Suppress Footer    ║
  78.      │  Header Margin      ║
  79.      │  Footer Margin      ║
  80.      └─────────────────────╜
  81. FMTCODEMISC MISCELLANEOUS FORMAT CODES
  82.  
  83. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Misc
  84. KEYSTROKES:    <F2> L C M^b
  85.  
  86.  
  87.                ┌────MISCELLANEOUS────╖
  88.                │                     ║
  89.                │  Page Breaks        ║
  90.                │  Center line        ║
  91.                │  Comment line       ║
  92.                │  Ignore line        ║
  93.                │  Define user code   ║
  94.                ╘═════════════════════╝
  95.  
  96.  
  97.  
  98.     (Sub-Menu, Data Entry and/or Immediate Action)  From the
  99.     Miscellaneous Format Codes sub-menu, you can cause the insertion
  100.     of any of the following codes at the cursor point in the current file:
  101.  
  102.     .pb n    Pressing <ENTER> when the highlight bar is on the
  103.         `page Break' selection will bring up a data entry box
  104.         requesting the number of the next page in the
  105.         document.  As soon as the page number is keyed in and
  106.         <ENTER> is pressed, the code .pb n (n = next page
  107.         number) is inserted into the document at the cursor.
  108.         When the file printed, a page break will occur at the
  109.         point of insertion and the next page will be numbered
  110.         as specified.
  111.  
  112.     .ce    Pressing <ENTER> at the `Center' option will
  113.         immediately cause a `.ce' code to be inserted at the
  114.         cursor point in the current file.  When the file is
  115.         formatted for printing, this line will be centered
  116.         between the margins.
  117.  
  118.     .np    Choosing the `cOmment' option will insert an `.np'
  119.         code at the cursor point in the current file.  This
  120.         line will not be output to the .PRT file, but it
  121.         will be decoded.  Comment lines are useful for
  122.         defining headers and footers, setting margins,
  123.         etc., without having the line printed as normal
  124.         text.
  125.  
  126.     .ig    The `iGnore' option will insert the `.ig' code into
  127.         the current file at the cursor.   This will send the
  128.         line to the .PRT file for output, but any formatting
  129.         codes contained in the line will not be processed.
  130.         This is particularly useful for printing a format code
  131.         literally.
  132.  
  133.     .du n    The `Define user code' option allows you to define
  134.         `macro-style' formatting commands and execute them in a
  135.         search-and-replace manner throughout the file.  There
  136.         are two distinct codes associated with this option:
  137.         `.du n' (the DEFINE code) and `.ud n' (the EXECUTE
  138.         code).  When this option is selected, a data entry box
  139.         will appear, requesting a number within the range of 1
  140.         to 10 (inclusive) to be assigned to this user-defined
  141.         formatting command.  The code .du n (n = assigned
  142.         number) will then be inserted into the file at the
  143.         cursor and everything that follows, including normal
  144.         text and other formatting commands, up to the
  145.         end-of-line, is considered part of the user-defined
  146.         command.  Thereafter, each time the code `.ud n' is
  147.         encountered, the `execute' command is replaced by the
  148.         definition string.  It should be noted that the maximum
  149.         string length for the definition is 255.  If the
  150.         definition string exceeds that maximum, it will be
  151.         truncated, yielding unpredictable results.
  152. FMTCODEVAR VARIABLE FORMAT CODES
  153.  
  154. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Variable
  155. KEYSTROKES:    <F2> L C V^b
  156.  
  157.                ┌──────VARIABLES──────╖
  158.                │                     ║
  159.                │  Filename           ║
  160.                │  Time               ║
  161.                │  Date               ║
  162.                │  Page Number        ║
  163.                ╘═════════════════════╝
  164.  
  165.     (Sub-Menu, Immediate Action - No Further Input)  Pressing
  166.     <ENTER> while the highlight bar is on any of the above
  167.     selections will insert the corresponding format code at the
  168.     cursor point in the current file.  These codes, in turn, will
  169.     cause the current value of the designated variable to be
  170.     inserted at that point in the text when the .PRT file is
  171.     created.  (See @PF[Print Formatter] for additional information on
  172.     creating .PRT files.)  The variable format codes are as follows:
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.         .fn  -  Inserts the current filename.
  180.  
  181.         .ti  -    Inserts the time of day.
  182.  
  183.         .da  -    Inserts the current date.
  184.  
  185.         .pa  -     Inserts the current page number.
  186.  
  187.  
  188.  
  189. FMTCODEATT FORMAT CODES - ATTRIBUTES
  190.  
  191. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Attributes
  192. KEYSTROKES:    <F2> L C A^b
  193.  
  194.  
  195.                ┌─────ATTRIBUTES──────╖
  196.                │                     ║
  197.                │  Underline Begin    ║
  198.                │  Underline End      ║
  199.                │  Emphasized Begin   ║
  200.                │  Emphasized End     ║
  201.                │  Italics Begin      ║
  202.                │  Italics End        ║
  203.                │  Doublewide Begin   ║
  204.                │  Doublewide End     ║
  205.                ╘═════════════════════╝
  206.  
  207.  
  208.     (Sub-Menu, Immediate Action - No Further Input)  When one of
  209.     the above items is selected by positioning the highlight bar
  210.     over it and pressing <ENTER>, the appropriate format code is
  211.     inserted into the current file at the cursor position.
  212.  
  213.     `Underline' and `Italics' are self-explanatory; `Emphasized is
  214.     equivalent to BOLD and `Doublewide' is equivalent to EXPANDED
  215.     print.  All of these codes are printer-specific and the user
  216.     should check the @ME.HLP^IN[Install] and @ME.HLP^PR[Print] menus to verify the
  217.     assigned printer before formatting the file.  The Attribute
  218.     codes are as follows:
  219.  
  220.             .u1  =    Underline On
  221.             .u0  =    Underline Off
  222.             .e1  =    Emphasized On
  223.             .e0  =    Emphasized Off
  224.             .i1  =    Italic On
  225.             .i0  =    Italic Off
  226.             .d1  =    Doublewide On
  227.             .d0  =    Doublewide Off
  228.  
  229.  
  230. FMTCODEPGSTUP PAGE SETUP FORMAT CODES
  231.  
  232. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Page Setup
  233. KEYSTROKES:    <F2> L C P^b
  234.  
  235.  
  236.                ┌─────PAGE SETUP──────╖
  237.                │                     ║
  238.                │  Line Spacing       ║
  239.                │  Page Length        ║
  240.                │  Right Margin       ║
  241.                │  Left Margin        ║
  242.                │  Top Margin         ║
  243.                │  Bottom Margin      ║
  244.                │  Form Feeds         ║
  245.                ╘═════════════════════╝
  246.  
  247.  
  248.     (Sub-Menu, Data Entry)  When any of the above items is selected,
  249.     a data entry box will appear requesting input of a value -
  250.     except for the last item, Form Feeds.  That will bring up a
  251.     dialog box in which you can toggle On/Off (using the <ENTER>
  252.     key) whether a form feed is to be issued at each page break.
  253.  
  254.     The codes are as follows:
  255.  
  256.         .ls n    Line spacing    (default = 1)
  257.         .pl n    Page length    (default = 66)
  258.         .rm n    Right margin    (default = 80)
  259.         .lm n    Left margin    (default = 1)
  260.         .tm n    Top margin    (default = 5)
  261.         .bm n    Bottom margin    (default = 60)
  262.         .ff n    Form feed    (default = Off)
  263.  
  264.  
  265. FMTCODEHDRFTR FORMAT CODES - HEADERS/FOOTERS
  266.  
  267. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Headers/Footers
  268. KEYSTROKES:    <F2> L C H^b
  269.  
  270.     (Sub-Menu, Immediate Action and/or Data Entry)  These items deal
  271.                   with the definition and placement of
  272.     ┌───HEADERS/FOOTERS───╖      headers and footers within the text.  In
  273.     │                     ║      defining headers and footers, everything
  274.     │  Define Header      ║      to the right of a .dh or .df code, up to
  275.     │  Define Footer      ║      the end-of-line, is considered to be
  276.     │  Suppress Header    ║      part of the definition (maximum string
  277.     │  Suppress Footer    ║      length = 255).  The following format
  278.     │  Header Margin      ║      codes can be used within a header or
  279.     │  Footer Margin      ║      footer definition:  .ce (center this
  280.     ╘═════════════════════╝      line); .fn (insert current filename);
  281.     .ti (insert current time-of-day); .da (insert today's date); .pa
  282.     (insert current page number); and all @FMTCODEATT[printer-specific codes]
  283.     (underline, italics, etc.).
  284.  
  285.  
  286.  
  287.  
  288.     NOTE:  When inserting a header/footer code, you will be prompted
  289.     to indicate whether it will be for a Primary or Secondary header
  290.     or footer.  A primary header/footer prints only on ODD pages if
  291.     a secondary header/footer is defined to print on EVEN pages;
  292.     otherwise, the primary header/footer prints on all pages.
  293.  
  294.     The header/footer format codes are as follows:
  295.  
  296.     .dh str...    Defines text string to be printed as header;
  297.             (default: blank string)
  298.     .df str...    Defines text string to be printed as footer;
  299.             (default: blank string)
  300.     .sh        Suppress header printing, this page only
  301.     .sf        Suppress footer printing, this page only
  302.     .hm n        Set header margin to n;
  303.             (default: n = 2)
  304.     .fm n        Set footer margin to n;
  305.             (default: n = 64)
  306. TOFC TABLE OF CONTENTS GENERATOR
  307.  
  308. ^BMENU ACCESS:    @ME.HLP^FIXEDMENU[Main Menu]-->@ME.HLP^LAYOUT[Layout]-->@FMTCODES[Format Codes]-->Table-of-contents
  309. KEYSTROKES:    <F2> L C T^b
  310.  
  311.     (Sub-Menu, Data Entry)  The Table-of-Contents Generator is an
  312.                 integral part of the @PF[Print Formatter].  It
  313.        ┌─TABLE OF CONTENTS─╖    enables you to generate a table of contents
  314.        │                   ║    with up to five indentation levels and four
  315.        │  Define Table     ║    different styles.  The first selection,
  316.        │  Table Entry      ║    Define Table, will request parameters, one
  317.        ╘═══════════════════╝    at a time, for the following items:
  318.                 right margin (the column in which to
  319.     right-justify page numbers); whether to use periods (.....) between
  320.     the entry and the corresponding page number; then - a) the number of
  321.     columns to indent the entries and, b) the style number to assign the
  322.     entries - for Levels 1 through 5, respectively.  It should be noted
  323.     that Level 1 indent is the number of columns from (the current left
  324.     margin/column 1)??, while subsequent indents are offsets from the
  325.     previous level.  The next parameters that will be requested are style
  326.     numbers for each level of entry.  The styles available are as follows:
  327.  
  328.         STYLE NO.       STYLE NAME                EXAMPLE
  329.         ---------      -------------         -------------------
  330.         0          plain vanilla         COMPILING A MACRO
  331.  
  332.         1             numeric             1. COMPILING A MACRO
  333.  
  334.         2              alpha         B. COMPILING A MACRO
  335.  
  336.         3           roman numeral         IV. COMPILING A MACRO
  337.  
  338.  
  339.     After the first two parameters - a right margin setting and a Yes
  340.     or No response to the use of periods between the table entries and
  341.     their page numbers - a message is displayed at the bottom of the
  342.     data entry box indicating that you can press the <ESC> key to
  343.     accept defaualt values for the remaining parameters.  The
  344.     default values for all of the entries are as follows:
  345.  
  346.         Right margin        = 75
  347.         (.....) Yes/No ?    = No (spaces will be used)
  348.         Level 1 indent        =
  349.         Level 2 indent        =    (TEST THESE OFFSETS)!!
  350.         Level 3 indent        =
  351.         Level 4 indent        =
  352.         Level 5 indent        =
  353.         Style, all levels    = 0 (plain vanilla)
  354.  
  355.     When all of the parameters have been entered, a code, similar to
  356.     the following representation will be inserted at the cursor
  357.     position in the current file:
  358.  
  359.             .tc 55 1 5 3 5 2 5 1 5 2 5 0
  360.  
  361.     Once the parameters have been stored, a .te designation is
  362.     required to identify table entries.  This can be achieved either
  363.     by keying in a `.te n' code during text entry (n = indent level
  364.     1 through 5) or using the Menu Access method to insert the code
  365.     at the cursor point in the current file.
  366.